home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 21 / Cream of the Crop 21 (Terry Blount) (October 1996).iso / database / tickle15.zip / TKLFILE.DOC < prev    next >
Text File  |  1996-08-02  |  29KB  |  757 lines
  1. Tickle File -  Version 1.50
  2. Written by Dan Shore - SysOp
  3.            The Shoreline BBS
  4.            August 2, 1996
  5.  
  6.  
  7. 1.  TKL.PPE - Tickle File - The main program
  8.     ────────────────────────────────────────
  9.  
  10.    "Tickle File" is a program which maintains a personal database for
  11.    each user that accesses/uses "Tickle File".  This personal database
  12.    can contain up to 24 filenames with an optional 15 character
  13.    description to "Tickle" their memory.  Tickle a user's memory for
  14.    what you ask?  Good question.
  15.  
  16.    Let's say you were on the BBS today and wanted to download a file,
  17.    but you did not have enough time or bytes remaining to perform the
  18.    download. You could then add this filename with a short description
  19.    (to help remind you what the file was) to your database, and next
  20.    time you are on the BBS, you view your database, "Tickle" your memory,
  21.    and download the file(s) you wanted (If the BBS restrictions allow
  22.    you too during this session).
  23.  
  24.    - What will the user see when Tickle File is invoked?
  25.  
  26.  
  27. A.  When invoking Tickle File from a PCB Menu
  28.     ─────────────────────────────────────────
  29.  
  30.    When a user invokes Tickle File from a PCB Menu, they will be presented
  31.    with the following screen:
  32.  
  33.     ┌────────────────────────────────────────────────────────┐
  34.     │  T I C K L E   F I L E - Tickle your memory for that   │
  35.     │  Written by:             file you wanted to download   │
  36.     │   Dan Shore              during a previous session.    │
  37.     ├────────────────────────────────────────────────────────┤
  38.     │  A)dd..... Add new file(s) to your Tickle List         │
  39.     │  D)elete.. Delete file(s) from your Tickle List        │
  40.     │  F)lag.... Flag file(s) in Tickle List for downloading │
  41.     │  H)elp.... Display this file                           │
  42.     │  L)ist.... List all files in your Tickle List          │
  43.     │  W)ipeOut. Wipeout (delete) your entire Tickle List    │
  44.     └────────────────────────────────────────────────────────┘
  45.  
  46.   Command: A)dd,D)elete,E)dit,F)lag,H)elp,L)ist,W)ipeOut [ENTER] = Quit ?
  47.  
  48.  
  49.    I believe the choices are fairly intuitive, but the menu (which is
  50.    called "HELP") can be modified by the sysop for better
  51.    display/explanation.  (The reason it is called help, is due to the
  52.    menu only being shown when you first enter TKL.PPE.  By choosing "H",
  53.    the user can have it redisplayed at anytime).
  54.  
  55.  
  56. B.  When "Tickle File" is invoked due to a violation (PCBText invokes
  57.     the PPE), the user will see the following (this example will use
  58.     PCBText number 159 for exceeding download daily byte limits -
  59.     FILENAME.ZIP = 522,856 bytes)
  60.  
  61.  
  62.  *──────────────────────────────────────────────────────────────────*
  63.  Sorry, Dan, not enough bytes remaining to process (FILENAME.ZIP)
  64.  
  65.  Total Download bytes available  : 307,200
  66.  Bytes used flagging files       : 522,856
  67.  Bytes used downloading files    : 0
  68.  Bytes left for downloading files: 307,200
  69.  
  70.  Bulletin #19 explains security levels and access restrictions
  71.  *──────────────────────────────────────────────────────────────────*
  72.  
  73.     You can add this file to your 'Filename Tickle List'
  74.  
  75.     A "Tickle List" is a personal database that can hold up to
  76.     24 filenames, with an optional short 15 character description,
  77.     to help "TICKLE" your memory for files you wanted to download
  78.     on a previous day. (Use the "TF" command at the Main Menu to
  79.     access your database)
  80.  
  81.     Just hit ENTER is you wish to bypass this feature....
  82.  
  83.     Add this file to your Tickle List (Y,[N]) ?
  84.  
  85.  
  86. -  The first section (within the two lines) is "PCBT159" (which is
  87.    modifiable by the SysOp) and can show whatever information you want
  88.    to the user (Bulletins to read, messages, etc.)  It is suggested
  89.    you keep the first line of text, as it is the same text from the
  90.    PCBText entry.
  91.  
  92. -  The second section is called "INFO" (which again is modifiable by the
  93.    SysOp) and it helps explain what "Tickle File" is all about.  This
  94.    file is displayed only when PCBText invokes the PPE.  Make sure to
  95.    modify the file "INFO" to match the command you used in CMD.LST.
  96.    (See section #2 below on installation)
  97.  
  98.    If the user responds to this prompt with a "Yes", they are prompted for
  99.    to add a short 15 character description to help them remember the
  100.    file they added to their database next time they were on.
  101.  
  102.  
  103. 2.  Installation:
  104.     ─────────────
  105.  
  106.  
  107. A.  Make a directory and unzip the entire contents of the archive into
  108.     this directory. (I would recommend a directory structure where all
  109.     your PPE's have their own directory located under a PPE directory.
  110.     This of course is optional and entirely up to you)
  111.  
  112. B.  Add an entry to your CMD.LST file.  Here is an example:
  113.  
  114.     Note:  You can make your COMMAND anything you wish, TF just
  115.            makes sense for "Tickle File"
  116.  
  117.                         Charges Per     PPE/MNU File Specification -or-
  118.        Command    Sec  Minute    Use    Keystroke Substitution
  119.    ══════════════ ═══ ═════════════════ ═════════════════════════════════
  120.    TF               5        0        0 C:\PCB\PPE\TKL\TKL.PPE MENU
  121.  
  122.    This entry is for a user to use Tickle File from one of your menus.
  123.  
  124.    NOTE:  Make sure to adjust the security level to match your system
  125.  
  126.    NOTE:  The "MENU" parameter instructs the PPE that you have entered the
  127.           program via a command and not a violation (PCBText invokes the
  128.           PPE when a violation occurs).
  129.  
  130. C.  Make changes to your PCBText file
  131.  
  132.    You can run the batch file included in the archive (CHNGPCBT.BAT) to
  133.    change your PCBText file for you (automated way).  Make sure you run the
  134.    batch file from the same directory where your PCBTEXT file is located,
  135.    *OR* change the batch file to match the path to your PCBTEXT file (see
  136.    example below)
  137.  
  138.   MKPCBTXT PCBTEXT /I:138 "!C:\PCB\PPE\TKL\TKL.PPE @OPTEXT@ 138"
  139.  
  140.   MKPCBTXT C:\PCB\GEN\PCBTEXT /I:138 "!C:\PCB\PPE\TKL\TKL.PPE @OPTEXT@ 138"
  141.  
  142.  
  143.    You can also change your PCBText by hand.  The following will give you a
  144.    guideline for the changes which need to be done.
  145.  
  146.     NOTE: You need to pass TWO parameters
  147.           (REQUIRED for proper operation):
  148.  
  149.     1. @OPTEXT@ for the filename
  150.     2. The PCBText number
  151.  
  152.     NOTE:  Make sure to change the path of the PPE to match your system.
  153.  
  154.     Change PCBTEXT entry 138 to:
  155.     !C:\PCB\PPE\TKL\TKL.PPE @OPTEXT@ 138
  156.  
  157.     Change PCBTEXT entry 159 to:
  158.     !C:\PCB\PPE\TKL\TKL.PPE @OPTEXT@ 159
  159.  
  160.     Change PCBTEXT entry 555 to:
  161.     !C:\PCB\PPE\TKL\TKL.PPE @OPTEXT@ 555
  162.  
  163.     Change PCBTEXT entry 668 to:
  164.     !C:\PCB\PPE\TKL\TKL.PPE @OPTEXT@ 668
  165.  
  166.     Change PCBTEXT entry 669 to:
  167.     !C:\PCB\PPE\TKL\TKL.PPE @OPTEXT@ 669
  168.  
  169.     Change PCBTEXT entry 670 to:
  170.     !C:\PCB\PPE\TKL\TKL.PPE @OPTEXT@ 670
  171.  
  172.     Change PCBTEXT entry 674 to:
  173.     !C:\PCB\PPE\TKL\TKL.PPE @OPTEXT@ 674
  174.  
  175.     Change PCBTEXT entry 675 to:
  176.     !C:\PCB\PPE\TKL\TKL.PPE @OPTEXT@ 675
  177.  
  178.     *****************************************************************
  179.     NOTE:  Make sure to REVIEW each PCBT???? file modifying any text
  180.            in these files to match your system setup.
  181.     *****************************************************************
  182.  
  183.  
  184. D.  TKL.PPE Configuration File
  185.  
  186.    There is a configuration file to use with TKL.PPE and it is called
  187.    TKLx.CFG (x = conference number for which the configuration file will
  188.    apply to).  The three lines of the configuration file are:
  189.  
  190.  
  191.    1. (TRUE or FALSE)  Check for file existence before adding the file
  192.                        to the database.  If the file is being added by
  193.                        PCBText invoking the PPE, then a file check is
  194.                        not needed, since PCB already checked the files
  195.                        existence.  If the user is adding a file
  196.                        manually, then this parameter will determine
  197.                        if the files existence is checked.
  198.                        TRUE  = Check for files existence
  199.                        FALSE = Do not check for files existence
  200.  
  201.   2.  (TRUE or FALSE